lineOffset

Type

function

Summary

Returns the number of lines between the beginning of a value and an occurrence of a specified string.

Syntax

lineOffset(<lineToFind>, <stringToSearch> [, <linesToSkip>])

Description

Use the lineOffset function to find which line a string occurs in.

The value returned by the lineOffset function is the number of the line where lineToFind first appears in stringToSearch. If the lineToFind is not in stringToSearch, the lineOffset function returns zero. If the lineToFind spans more than one line, the lineOffset function always returns zero, even if the lineToFind appears in the stringToSearch.

If you specify how many linesToSkip, the lineOffset function skips the specified number of lines in the stringToSearch. The value returned is relative to this starting point instead of the beginning of the stringToSearch.

Parameters

Name	Type	Description
lineToFind	string
stringToSearch	string
linesToSkip		A non-negative integer. If you don't specify how many linesToSkip, the lineOffset function does not skip any lines.

Examples

lineOffset("cheese",foodsList)

put subbedData into line (lineOffset(it,receivedData)) of receivedData

Related

control structure: function

function: wordOffset, offset, value

glossary: return, non-negative

keyword: integer, line, string, lines

property: wholeMatches

Compatibility and Support

Introduced

LiveCode 1.0

OS

mac

windows

linux

ios

android

Platforms

desktop

server

mobile